QuerySubscriptionServices

The QuerySubscriptionServices web service XML- or JSON-based information exchange systems that use the Internet for direct application-to-application interaction. These systems can include programs, objects, messages, or documents. enables an external client system to query a Subscription A billing entity that incurs a charge. Examples include a network attached device whose usage you want to measure and charge for, or a monthly software subscription Service and return the additional contract information linked with Subscription Service records.

For example, this service allows a subscriber The end user of a network. to request remaining contract period details for Subscription Contract Services.

QuerySubscriptionServices Request

The QuerySubscriptionServices tag instructs the Subscription Service to query Subscription details. This request contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	The client may use this identifier to correlate the request and the response.	Optional
SubscriptionNumber	Integer8	Indicates the unique system generated Subscription Number.	Mandatory
StatusFilter	String	Possible Values ALL ACTIVE The element determines whether all Subscription Services are returned or just those which are currently active.	Mandatory

Sample QuerySubscription Services Request

QuerySubscriptionServices Response

The QuerySubscriptionServices response is the response to the QuerySubscriptionServices Request. This contains the following elements:

Element Name	Content Type	Description	Required?
ExternalReference	String69	Returned unmodified in the response. The client may use this identifier to correlate the request and the response.	Optional
SubscriptionServices	Container	Contains a list of zero or more Subscription Service elements. See QuerySubscriptionServices Response Container for details.	Mandatory
QueryLimitExceeded	Boolean	Set to True if the maximum number of records that may be returned as defined in the configuration, was exceeded	Mandatory

SubscriptionServices Response Container

The SubscriptionServices response container has the following elements:

Element Name	Content Type	Description	Required?
SubscriptionService	Container	See SubscriptionService response container for details	Optional

SubscriptionService Response Container

The SubscriptionService response container has the following elements:

Element Name	Content Type	Description	Required?
ServiceCode	String6	Unique ID for the Service.	Mandatory
EffectiveDate	Date	YYYY-MM-DD	Mandatory
ExpiryDate	Date	YYYY-MM-DD	Optional
ServiceDescription	String30	A description of the Service linked to the Subscription.	Optional
Price	Decimal (9,2)	Price at which the Service is charged.	Optional
NominalCode	String30	The Nominal Code to which the Subscription Service is charged.	Optional
InvoiceThisService	Boolean	Set to True if the Subscription Service is eligible for invoicing.	Optional
LongDescription	String120	This details a longer descriptive text attributed to the Service (120-characters).	Optional
PackageCode	String6	Unique ID for the Package used to add the Subscription Service.	Optional
PricePeriodCoverage	Container	See PricePeriodCoverage Response Container for details.	Optional
SalesAccountNumber	Integer8	Sales Account Number of the salesperson who introduced the customer to the Service.	Optional
BillingOffset	Integer2	The period by which Service is billed in advance.	Optional
AddingEvent	Integer9	Account Services can be added by Workflow Events. This element contains the ID of the Workflow Event that added this Service.	Optional
NetworkConfirmed	Boolean	Set to True if the Subscription Service request has been confirmed at Network level.	Optional
Migrated	Boolean	Set to True if the Subscription has been migrated between tariffs.	Optional
PerBill	Boolean	Set to True if the Service is charged on each bill. Set to False for a one-off payment.	Optional
BilledUntil	Date	YYYY-MM-DD The last date on which the customer was billed for the Service.	Optional
ServiceBarred	Boolean	Set to True if the Service is barred.	Optional
RecurringCharge	Boolean	Set to True if a recurring Service Charge is to be applied to the Account.	Optional
ContractService	Boolean	The value to be retrieved from the Service Code set up.	Optional
ContractDuration	Integer3	The value to be retrieved from the Service Code set up.	Optional
ContractReference	String12	A 12-character reference ID that can be assigned to the service contract. This field is displayed for Contract Services only.	Optional
SuppressRemaining ContractCharge	Boolean	This is a Yes/No option which is used by Invoice Production to determine whether or not to apply the Contract Expiry Charge to the subscriber as part of generating the invoice.	Optional
PriceConsolidationService	String6	This indicates the name of the Discount Consolidated Service applied to the selected Subscription Service in CMP diseMP Back Office.	Optional
LastAmendedDate	Date	YYYY-MM-DD	Optional

PricePeriodCoverage Response Container

The PricePeriodCoverage response container has the following elements:

Element Name	Content Type	Description	Required?
CoverageType	String	Enumeration: Days Months	Mandatory
CoverageValue	Integer3	The value of the coverage during the selected period.	Mandatory

Sample QuerySubscriptionServices Response